UseCase Create Partner => Partner: P-31010 - Test AG

A partner can be a client or a vendor, currently we only use them for clients.

Properties

Given

name value
partnerNumber P-31010
personType LEGAL_PERSON
tradeName Test AG
contactCaption Test AG - Hamburg
postalAddress         “firm”: “Test AG”,
        “department”: “Geschäftsleitung”,
        “street”: “Shanghai-Allee 1”,
        “zipcode”: “20123”,
        “city”: “Hamburg”,
        “country”: “Germany”
officePhoneNumber +49 40 654321-0
emailAddress hamburg@test-ag.example.org
registrationOffice Registergericht Hamburg
registrationNumber 1234567

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "806e75fe-7894-4422-86be-783107f07f3f", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Test AG

HTTP POST "/api/hs/office/persons" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Test AG"
}
EOF
=> status: 201 CREATED 00ddd2fc-8742-46e5-924c-77749d4c8ccc

Contact: Test AG - Hamburg

HTTP POST "/api/hs/office/contacts" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "caption" : "Test AG - Hamburg",
  "postalAddress" : {
    "firm" : "Test AG",
    "department" : "Geschäftsleitung",
    "street" : "Shanghai-Allee 1",
    "zipcode" : "20123",
    "city" : "Hamburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 40 654321-0"
  },
  "emailAddresses" : {
    "main" : "hamburg@test-ag.example.org"
  }
}
EOF
=> status: 201 CREATED 781f566a-af3e-4e71-9411-b6a0fbfa317e

Create Partner: P-31010 - Test AG

HTTP POST "/api/hs/office/partners" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }` \
  <<EOF
{
  "partnerNumber" : "P-31010",
  "partnerRel" : {
    "anchor.uuid" : "806e75fe-7894-4422-86be-783107f07f3f", // Person: Hostsharing eG
    "holder.uuid" : "00ddd2fc-8742-46e5-924c-77749d4c8ccc", // Person: Test AG
    "contact.uuid" : "781f566a-af3e-4e71-9411-b6a0fbfa317e" // Contact: Test AG - Hamburg
  },
  "details" : {
    "registrationOffice" : "Registergericht Hamburg",
    "registrationNumber" : "1234567"
  }
}
EOF
=> status: 201 CREATED 3da9e2a0-95cc-4ea4-bb4c-e73ad571beb4

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Test+AG+-+Hamburg" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-alex_superuser>"` \
  `# }`
=> status: 200 OK 
[ {
  "uuid" : "f1943189-716b-46ea-8218-fa169740db15",
  "anchor" : {
    "uuid" : "806e75fe-7894-4422-86be-783107f07f3f", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "00ddd2fc-8742-46e5-924c-77749d4c8ccc", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "781f566a-af3e-4e71-9411-b6a0fbfa317e", // Contact: Test AG - Hamburg
    "caption" : "Test AG - Hamburg",
    "postalAddress" : {
      "zipcode" : "20123",
      "firm" : "Test AG",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "Shanghai-Allee 1",
      "department" : "Geschäftsleitung"
    },
    "emailAddresses" : {
      "main" : "hamburg@test-ag.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 654321-0"
    }
  }
} ]

generated on 2026-08-10 01:37:51 for branch